cs-notifications-papi
📘 Documentación de la API - CS Notifications PAPI
Esta sección describe los atributos y uso de la cs-notifications-papi, versión 1.0.0. Es una API de Proceso para enviar mensajes SMS y Email.
💂️ Información Base
- Título de la API: cs-notifications-papi
- Versión: 1.0.0
- URL Base:
https://cs-notifications-papi.cloudhub.io/
🔑 Autenticación
Encabezados Requeridos
| Encabezado | Tipo | Descripción |
|---|---|---|
| Authorization | String | Token Bearer en el formato Bearer {{API_KEY}} |
| client_id | String | Identificador único para clientes API |
📌 Estos encabezados son requeridos en todas las solicitudes.
✨ Endpoints
📧 Enviar Correo Electrónico
POST /email
- Descripción: Envía mensajes de correo electrónico con archivos adjuntos opcionales o contenido codificado en base64.
Parámetros del Cuerpo (multipart/form-data)
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
| files | file[] | ❌ | Archivo(s) a ser subidos |
| body | object | ✅ | Detalles del email (destinatarios, asunto, etc.) |
| base64 | string | ❌ | PDF codificado en Base64 |
📎 Ejemplo: examples/request/post-send-email.json
📎 Ejemplo de Respuesta: examples/response/post-send-email.raml
🔍 Rastrear Notificaciones de Email
GET /email/notification-track
- Descripción: Obtiene detalles de seguimiento para emails enviados usando la cuenta notification-track.
Parámetros de Consulta
| Parámetro | Tipo | Ejemplo | Requerido | Descripción |
|---|---|---|---|---|
| filter | String | {"mail_to":"juan.garcia@correo.com"} | ❌ | Criterios de filtro para seguimiento de email |
📎 Ejemplo: examples/response/get-email-notification-track.json
📩 Enviar SMS
POST /sms
- Descripción: Envía mensajes SMS a través del proveedor predeterminado.
📎 Ejemplo de Solicitud: examples/request/post-send-sms.raml
📎 Ejemplo de Respuesta: examples/response/post-send-sms.raml
📡 Enviar SMS vía Twilio
POST /twilio/sms
- Descripción: Envía mensajes SMS a través de Twilio.
📎 Ejemplo de Solicitud: examples/request/post-send-sms-twilio.json
📎 Ejemplo de Respuesta: examples/response/post-send-sms-twilio.json
🔎 Rastrear Notificaciones de Email (v2)
GET /v2/email/notification-track
- Descripción: Obtiene detalles de seguimiento con filtros de proveedor y cuenta.
Parámetros de Consulta
| Parámetro | Tipo | Ejemplo | Requerido | Descripción |
|---|---|---|---|---|
| providerId | String | 10225e9b-87ed-4875-a959-6835061cbc97 | ❌ | ID del proveedor de email |
| accountId | String | 8e109488-4617-40ca-b67c-efcb83d566f2 | ❌ | ID de la cuenta de email |
| filter | String | {"mail_to":"juan.garcia@correo.com"} | ❌ | Criterios de filtro |
📎 Ejemplo: examples/response/get-email-notification-track.json
🔐 Esquemas de Seguridad
Aplicación de ID de Cliente
| Campo | Tipo | Requerido | Longitud | Regex |
|---|---|---|---|---|
| client_id | String | Sí | 32 - 36 | [a-zA-Z0-9] |
OAuth 2.0
| Campo | Tipo | Requerido | Longitud | Regex |
|---|---|---|---|---|
| Authorization | String | Sí | 36 - 37 | [a-zA-Z0-9-_.] |
⚠️ Códigos de Error
| Código | Descripción | Solución Sugerida |
|---|---|---|
| 400 | Solicitud Incorrecta | Verificar datos de entrada y formato. |
| 401 | No Autorizado | Verificar credenciales de autenticación. |
| 404 | No Encontrado | Recurso solicitado no encontrado. |
| 500 | Error Interno del Servidor | Reintentar o contactar soporte técnico. |
📞 Soporte
Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.
Correo electrónico: epalma@fgs.co
📅 Información Adicional
- Documentación actualizada por última vez: Septiembre 2025
- Para actualizaciones adicionales, consulta el Portal de Exchange de API
Documentación actualizada en Septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma
© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-utilities-system-api-services